Skip to main content

Carousel

Adding this widget will fetch the media against the portal you have bound and show the Media in carousel view.

Step 1: Add the following HTML in the body section of your web application code to add the carousel widget.

<vdz-mashup-carousel id="carousel" data-widget="true" > </vdz-mashup-carousel>

Note: Make sure data-widget is set to true as this applies the VIDIZMO default styling to the widget.

Step 2: The Carousel widget has multiple events that are triggered on the various status and lifecycle changes. Following code examples explain how to utilize event listeners to subscribe to these events.

<script>
    document.getElementById("carousel").addEventListener("on-mashups-loading", (event) => {
        console.log(event);
    console.log("onMashupLoading");
    });
    document.getElementById("carousel").addEventListener("on-mashups-loaded", (event) => {
        console.log(event);
    console.log("onMashupLoaded")
    });
    document.getElementById("carousel").addEventListener("on-mashups-loading-failed", (event) => {
        console.log(event);
    console.log("onMashupLoadingFailed")
    });
</script>

Note: Make sure the id you pass in the getElementById is the same as used in the widget tag. E.g. "carousel"

PropertyTypeDefaultRequiredDescription
search-criteriaMashupSearchCriteria NoThis is an object containing criteria(s) to search mashup(s) 
keywordstring NoIt will search mashups against the mentioned keyword  
order-byMashupOrderBy NoIt will order searched mashups according to the order-by possible values  
sort-typeSortType NoIt will sort searched mashups according to sort-type possible values  
is-featuredboolean NoIt will search all the featured mashups of the portal 
is-globalboolean NoIt will search among all the mashups of the portal  
show-on-channel-libraryboolean NoIt will search all the mashups visible on the channel library of the portal  
statusMashupStatus NoIt will search all mashups of different statuses of the portal   
item-xsnumber No 
item-smnumber No 
item-mdnumber No 
item-lgnumber No 
headingstring NoIt is the main heading of the widget

Output Events for Most Popular/Most Viewed/Most Recent Media Widget​

EventDataScenario
on-mashups-loadingmashupSearchCriteria:MashupSearchCriteriaWhen search criteria are changed and the call is not yet sent to the server.
on-mashups-loadedmashupInfo:MashupInfoUndefined is raised in case no mashups are returned from the server.
on-mashups-loading-failedexceptionWhen search call has failed.
on-slide-changednumberThe latest slide number will be returned.
on-play{t: number, mashupInfo:MashupInfo}This method will return time from where a user wants to playback and mashup the object that needs to be played.

Sample Code - VIDIZMO Carousel Widget​

<html>

    <head>
        <meta charset="UTF-8" />
        <!-- VIDIZMO Imports -->
        <script type="text/javascript"
            src="https://vidizmo-widgets.beta.vidizmo.com/static/js/vidizmo-player/player.js"></script>
        <link rel="stylesheet" href="https://vidizmo-widgets.beta.vidizmo.com/static/compiled/widget/widgets.css" />
        <script type="text/javascript"
            src="https://vidizmo-widgets.beta.vidizmo.com/static/compiled/widget/widgets.js"></script>
    </head>

    <body style="margin: 20px;">
        <vdz-mashup-carousel id="carousel" data-widget="true" page-size-md="4"
            search-criteria='{"sortType":"ASC","pageSize":36,"isGlobal":true,"showOnChannelLibrary":true,"isFeatured":true}'>
        </vdz-mashup-carousel>

        <script>
        document.getElementById("carousel").addEventListener("on-mashups-loading", (event) => {
                console.log(event);
            console.log("onMashupLoading");
        });
        document.getElementById("carousel").addEventListener("on-mashups-loaded", (event) => {
                console.log(event);
            console.log("onMashupLoaded")
        });
        document.getElementById("carousel").addEventListener("on-mashups-loading-failed", (event) => {
                console.log(event);
            console.log("onMashupLoadingFailed")
        });
        </script>

    </body>

</html>

Next Steps​

You can playback the content by simply clicking on the content within the Media Library Gallery Widget. Upon clicking the content, an event "onPlay()" would be raised and listened to. You will get two properties i.e. "Timestamp" and Mashup id which needs to be passed into the video/audio playback widget to be able to play the audio/video.

You can learn more about this in the following articles:

Scenario - Playback Media from Media Library